Skip to content

Preview for 26.06 release notes + make get-source#1353

Merged
validbeck merged 9 commits into
mainfrom
nrichers/sc-16263/release-notes-for-26-06
Jun 2, 2026
Merged

Preview for 26.06 release notes + make get-source#1353
validbeck merged 9 commits into
mainfrom
nrichers/sc-16263/release-notes-for-26-06

Conversation

@nrichers
Copy link
Copy Markdown
Contributor

@nrichers nrichers commented May 26, 2026

What and why?

This PR enables a temporary preview of the 26.06 release notes on the docs staging site and runs make get-source to refresh our library files.

Relates to:

BECK, PLEASE REMEMBER TO REMOVE THIS BRANCH REF BEFORE MERGING,

How to test

Wait for the Validate docs site workflow to finish, then check the live preview:

After making changes to the release notes draft, rerun the same workflow to refresh the preview site.

What needs special review?

Review the release notes content for accuracy and completeness.

Dependencies, breaking changes, and deployment notes

Release notes

N/A — preview only

Checklist

  • What and why
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied

Points to nrichers/sc-16263/release-notes-for-26-06 branch in release-notes repo.
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers changed the title Preview for 26.06 release notes Preview for 26.06 release notes + make get-source May 26, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

Comment thread .github/workflows/validate-docs-site.yaml Outdated
@nrichers nrichers requested a review from validbeck May 26, 2026 03:48
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers added the internal Not to be externalized in the release notes label May 26, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Execute training notebooks for PRs

✓ INFO: Live previews are available —

Comment thread .github/workflows/validate-docs-site.yaml Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

PR Summary

This PR introduces several functional updates and enhancements across deployment workflows, documentation templates, and notebooks. The key changes include:

  1. Deployment Workflow Updates:

    • The S3 sync commands in the GitHub Actions workflows (for production, staging, and PR previews) have been updated to include a cache control header (--cache-control "no-cache, max-age=0, must-revalidate"). This change forces browsers and clients to fetch the latest content instead of using stale cached versions.
  2. Template and Metadata Adjustments:

    • In the documentation template file, the generated-by footer timestamp has been updated to reflect a new generation date, ensuring documentation appears current.
    • The release listing file now includes an additional field (subtitle) in the list of fields, which may support richer metadata for release notes.
  3. Notebook Modifications and Additions:

    • In one of the test configuration notebooks, the API endpoint parameters have been updated from a localhost development endpoint to a production URL. This reflects a transition from development to production settings.
    • A new notebook for a quickstart guide using the OIDC device flow has been added. This comprehensive notebook provides detailed instructions and code blocks for model documentation that authenticates via OIDC rather than using static API keys.

Overall, the changes aim to ensure that deployed documentation is not adversely affected by caching, that the documentation metadata remains up to date, and that users have access to contemporary authentication methods and detailed quickstart material for model documentation.

Test Suggestions

  • Verify that the documentation sites on staging and production are updated immediately after deployment by checking the absence of cached content (e.g., by inspecting response headers for the cache-control directive).
  • Run the GitHub Actions workflows manually or in a test branch to ensure the new cache control parameter does not interfere with file syncing or CloudFront invalidation.
  • Execute the updated notebooks, particularly the new OIDC quickstart notebook, to confirm that all cells run as expected without errors and that the API endpoints are correctly reached.
  • Review the release listing page to confirm that the additional 'subtitle' field is displayed and formatted properly.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@validbeck validbeck merged commit 8b254c1 into main Jun 2, 2026
6 of 7 checks passed
@validbeck validbeck deleted the nrichers/sc-16263/release-notes-for-26-06 branch June 2, 2026 18:59
@validbeck validbeck mentioned this pull request Jun 2, 2026
11 tasks
validbeck added a commit that referenced this pull request Jun 2, 2026
* Merge pull request #1359 from validmind/beck/sc-15995/documentation-primary-record-types-phase

docs: Models  > Records — Reporting, Monitoring, Attestation

* Preview for 26.06 release notes + `make get-source` (#1353)

* Add temporary release-notes branch ref for 26.06 preview

Points to nrichers/sc-16263/release-notes-for-26-06 branch in release-notes repo.

* Run make get-source

* Add subtitle to all-releases page listing

* refreshing vm-library

* cache invalidation

* Update .github/workflows/validate-docs-site.yaml

Co-authored-by: Nik Richers <nik@validmind.ai>

* REF FOR PREVIEW, REMOVE BEFORE MERGE

* Update .github/workflows/validate-docs-site.yaml

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nik Richers <nrichers@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants